eKOK Dokumentacja Integracyjna
0.4.0 - draft Poland flag

Profil zasobu: PLeKOKAppointment

Logiczny url: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment Wersja: 0.4.0
Active z dnia 2026-02-16 Nazwa: PLeKOKAppointment

Profil zasobu zawierający zakres danych dotyczących rejestracji planowanej wizyty w ramach karty e-KOK

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Profil

Opis sposobu prezentacji profilu ujęty jest w specyfikacji standardu FHIR.

Struktura bazuje na Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
... id 0..1 id Identyfikator logiczny zasobu (wartość nadawana przez system P1)
... meta 1..1 Meta Metadane zasobu
.... id 0..0
.... extension 0..0
.... versionId 0..1 id Wersja zasobu (wartość ustawiana przez system P1)
.... lastUpdated 0..1 instant Data aktualizacji zasobu (wartość ustawiana przez system P1)
.... source 0..1 uri Identyfikator źródła zasobu (wartość ustawiana przez system, przy rejestracji lub aktualizacji zasobu)
.... profile 1..1 canonical(StructureDefinition) PLeKOKAppointment
Fixed Value: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment
.... tag 0..0
... implicitRules 0..1 uri Wersja systemu (wartość ustawiana przez system P1)
... language 0..1 code Language of the resource content
Required Pattern: pl
... text 0..0
... contained 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
.... extension:statusHistory 1..* (Complex) Historia statusów rejestracji. Ostatni status na liście historii statusów musi być tożsamy z aktualnym statusem rejestracji
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history
..... Slices for extension Content/Rules for all slices
...... extension:status 1..1 Extension status
....... value[x] 1..1 code status
Binding: PLeKOKAppointmentStatusVS (required)
...... extension:period 1..1 Extension Okres czasu, w którym status był aktualny
....... value[x] 1..1 Period Okres
........ start C 1..1 dateTime Data początku okresu
Constraints: date-pattern
........ end C 0..1 dateTime Data końca okresu
Constraints: date-pattern
...... extension:statusReason 0..1 Extension Przyczyna zmiany statusu
....... value[x] 0..1 CodeableConcept Przyczyna
Binding: PLeKOKAppointmentCancelationReasonVS (required)
........ coding 1..1 Coding Code defined by a terminology system
......... extension 0..0
......... system 1..1 uri System kodowania
......... version 0..0
......... code 1..1 code Kod
......... display 1..1 string Nazwa
......... userSelected 0..0
........ text 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... modifierExtension 0..0
... identifier 0..0
... status 1..1 code booked (wizyta zarejestrowana) | fulfilled (wizyta odbyła się) | cancelled (wizyta odwołana) | entered-in-error (wizyta błędnie zarejestrowana) | noshow (pacjent nie pojawił się)
Binding: PLeKOKAppointmentStatusVS (required)
... cancelationReason 0..1 CodeableConcept Przyczyna anulowania rejestracji na wizytę. Wymagany w przypadku ustawienia statusu na 'canceled'
Binding: PLeKOKAppointmentCancelationReasonVS (required)
.... coding 1..1 Coding Code defined by a terminology system
..... extension 0..0
..... system 1..1 uri System kodowania
..... version 0..0
..... code 1..1 code Kod
..... display 1..1 string Nazwa
..... userSelected 0..0
.... text 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... serviceCategory 1..1 CodeableConcept Kategoria
Binding: PLeKOKCardiacCareSeviceCategoryVS (required)
.... extension 0..0
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri System kodowania rodzajów świadzceń
Required Pattern: https://ezdrowie.gov.pl/ekok/fhir/CodeSystem/care-service-category-code-system
..... version 0..0
..... code 1..1 code phc | amb | imp
..... display 1..1 string Nazwa rodzaju świadczenia
..... userSelected 0..0
.... text 0..0
... serviceType 0..0
... specialty 0..0
... appointmentType 0..0
... reasonCode 0..0
... reasonReference 0..0
... priority 0..0
... description 0..0
... supportingInformation 0..0
... start 1..1 instant Planowana data i godzina rozpoczęcia wizyty
... end 1..1 instant Planowana data i godzina zakończenia wizyty
... minutesDuration 0..0
... slot 0..0
... created 1..1 dateTime Data rejestracji
... comment 0..0
... patientInstruction 0..0
... basedOn 1..1 Reference(ServiceRequest) Referencja do zasobu z danymi zlecenia wystawionego w ramach karty e-KOK
.... id 0..0
.... extension 0..0
.... reference 1..1 string Referencja do zasobu ServiceRequest
.... type 1..1 uri Typ zasobu (ServiceRequest)
Fixed Value: ServiceRequest
.... identifier 0..0
.... display 0..0
... Slices for participant 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Closed by value:actor.type
.... participant:patient 1..1 BackboneElement Pacjent
..... type 0..0
..... actor 1..1 Reference(Patient) Dane pacjenta
...... id 0..0
...... extension 0..0
...... reference 1..1 string Referencja do zasobu Patient
...... type 1..1 uri Typ zasobu z danymi pacjenta (Patient)
Fixed Value: Patient
...... identifier 0..0
...... display 0..0
..... required 0..0
..... status 1..1 code accepted | declined | tentative | needs-action
Fixed Value: accepted
..... period 0..0
.... participant:location 1..1 BackboneElement Placówka
..... type 0..0
..... actor 1..1 Reference(Location) Person, Location/HealthcareService or Device
...... id 0..0
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:healthcareLocationTechnicalCode 1..1 (Complex) Kod techniczny miejsca udzielania świadczeń
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code
........ id 0..0
........ value[x] 1..1 string Kod techniczny miejsca udzielania świadczeń
...... reference 0..0
...... type 1..1 uri Type the reference refers to (e.g. "Patient")
Fixed Value: Location
...... identifier 1..1 Identifier Identyfikator miejsce udzielenia świadczenia
....... id 0..0
....... extension 0..0
....... use 0..0
....... type 0..0
....... system 1..1 uri OID systemu identyfikacji Miejsca Udzielania Świadczeń
....... value 1..1 string Identyfikator Miejsca Udzielania Świadczeń
....... period 0..0
....... assigner 0..0
...... display 1..1 string Nazwa Miejsca Udzielania Świadczeń
..... required 0..0
..... status 1..1 code accepted | declined | tentative | needs-action
Fixed Value: accepted
..... period 0..0
... requestedPeriod 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.extension:statusHistory.​extension:status.value[x] Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.extension:statusHistory.​extension:statusReason.​value[x] Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.status Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.cancelationReason Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.serviceCategory Base required PLeKOKCardiacCareSeviceCategoryVS 📦0.4.0 This IG

Constraints

Id Grade Path(s) Description Expression
date-pattern error Appointment.extension:statusHistory.extension:period.value[x].start, Appointment.extension:statusHistory.extension:period.value[x].end Nieprawidłowy format daty (prawidłowy format daty: YYYY-MM-DD) $this.toString().matches('^\\d{4}-((0[0-9])|(1[012]))-(([012][0-9])|3[01])$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Identyfikator logiczny zasobu (wartość nadawana przez system P1)
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu (wartość ustawiana przez system P1)
.... lastUpdated Σ 0..1 instant Data aktualizacji zasobu (wartość ustawiana przez system P1)
.... source Σ 0..1 uri Identyfikator źródła zasobu (wartość ustawiana przez system, przy rejestracji lub aktualizacji zasobu)
.... profile Σ 1..1 canonical(StructureDefinition) PLeKOKAppointment

Fixed Value: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment
... implicitRules ?!Σ 0..1 uri Wersja systemu (wartość ustawiana przez system P1)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
.... extension:statusHistory 1..* (Complex) Historia statusów rejestracji. Ostatni status na liście historii statusów musi być tożsamy z aktualnym statusem rejestracji
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status 1..1 Extension status
....... extension 0..0
....... url 1..1 uri "status"
....... value[x] 1..1 code status
Binding: PLeKOKAppointmentStatusVS (required)
...... extension:period 1..1 Extension Okres czasu, w którym status był aktualny
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Okres
........ start ΣC 1..1 dateTime Data początku okresu
Constraints: date-pattern
........ end ΣC 0..1 dateTime Data końca okresu
Constraints: date-pattern
...... extension:statusReason 0..1 Extension Przyczyna zmiany statusu
....... extension 0..0
....... url 1..1 uri "statusReason"
....... value[x] 0..1 CodeableConcept Przyczyna
Binding: PLeKOKAppointmentCancelationReasonVS (required)
........ coding Σ 1..1 Coding Code defined by a terminology system
......... extension 0..0
......... system Σ 1..1 uri System kodowania
......... code Σ 1..1 code Kod
......... display Σ 1..1 string Nazwa
........ text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
..... url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history"
... status ?!Σ 1..1 code booked (wizyta zarejestrowana) | fulfilled (wizyta odbyła się) | cancelled (wizyta odwołana) | entered-in-error (wizyta błędnie zarejestrowana) | noshow (pacjent nie pojawił się)
Binding: PLeKOKAppointmentStatusVS (required)
... cancelationReason Σ 0..1 CodeableConcept Przyczyna anulowania rejestracji na wizytę. Wymagany w przypadku ustawienia statusu na 'canceled'
Binding: PLeKOKAppointmentCancelationReasonVS (required)
.... coding Σ 1..1 Coding Code defined by a terminology system
..... extension 0..0
..... system Σ 1..1 uri System kodowania
..... code Σ 1..1 code Kod
..... display Σ 1..1 string Nazwa
.... text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... serviceCategory Σ 1..1 CodeableConcept Kategoria
Binding: PLeKOKCardiacCareSeviceCategoryVS (required)
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri System kodowania rodzajów świadzceń
Required Pattern: https://ezdrowie.gov.pl/ekok/fhir/CodeSystem/care-service-category-code-system
..... code Σ 1..1 code phc | amb | imp
..... display Σ 1..1 string Nazwa rodzaju świadczenia
... start Σ 1..1 instant Planowana data i godzina rozpoczęcia wizyty
... end Σ 1..1 instant Planowana data i godzina zakończenia wizyty
... created 1..1 dateTime Data rejestracji
... basedOn 1..1 Reference(ServiceRequest) Referencja do zasobu z danymi zlecenia wystawionego w ramach karty e-KOK
.... extension 0..0
.... reference ΣC 1..1 string Referencja do zasobu ServiceRequest
.... type Σ 1..1 uri Typ zasobu (ServiceRequest)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Closed by value:actor.type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:patient C 1..1 BackboneElement Pacjent
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Patient) Dane pacjenta
...... extension 0..0
...... reference ΣC 1..1 string Referencja do zasobu Patient
...... type Σ 1..1 uri Typ zasobu z danymi pacjenta (Patient)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Patient
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted
.... participant:location C 1..1 BackboneElement Placówka
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Location) Person, Location/HealthcareService or Device
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:healthcareLocationTechnicalCode 1..1 (Complex) Kod techniczny miejsca udzielania świadczeń
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code
........ extension 0..0
........ url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code"
........ value[x] 1..1 string Kod techniczny miejsca udzielania świadczeń
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
...... identifier Σ 1..1 Identifier Identyfikator miejsce udzielenia świadczenia
....... extension 0..0
....... system Σ 1..1 uri OID systemu identyfikacji Miejsca Udzielania Świadczeń
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string Identyfikator Miejsca Udzielania Świadczeń
Example General: 123456
...... display Σ 1..1 string Nazwa Miejsca Udzielania Świadczeń
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.extension:statusHistory.​extension:status.value[x] Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.extension:statusHistory.​extension:statusReason.​value[x] Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.status Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.cancelationReason Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.serviceCategory Base required PLeKOKCardiacCareSeviceCategoryVS 📦0.4.0 This IG
Appointment.basedOn.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:patient.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:patient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:location.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:location.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant, Appointment.participant:patient, Appointment.participant:location Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
date-pattern error Appointment.extension:statusHistory.extension:period.value[x].start, Appointment.extension:statusHistory.extension:period.value[x].end Nieprawidłowy format daty (prawidłowy format daty: YYYY-MM-DD) $this.toString().matches('^\\d{4}-((0[0-9])|(1[012]))-(([012][0-9])|3[01])$')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Identyfikator logiczny zasobu (wartość nadawana przez system P1)
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu (wartość ustawiana przez system P1)
.... lastUpdated Σ 0..1 instant Data aktualizacji zasobu (wartość ustawiana przez system P1)
.... source Σ 0..1 uri Identyfikator źródła zasobu (wartość ustawiana przez system, przy rejestracji lub aktualizacji zasobu)
.... profile Σ 1..1 canonical(StructureDefinition) PLeKOKAppointment

Fixed Value: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... implicitRules ?!Σ 0..1 uri Wersja systemu (wartość ustawiana przez system P1)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
.... extension:statusHistory 1..* (Complex) Historia statusów rejestracji. Ostatni status na liście historii statusów musi być tożsamy z aktualnym statusem rejestracji
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status 1..1 Extension status
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "status"
....... value[x] 1..1 code status
Binding: PLeKOKAppointmentStatusVS (required)
...... extension:period 1..1 Extension Okres czasu, w którym status był aktualny
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Okres
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 1..1 dateTime Data początku okresu
Constraints: date-pattern
........ end ΣC 0..1 dateTime Data końca okresu
Constraints: date-pattern
...... extension:statusReason 0..1 Extension Przyczyna zmiany statusu
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "statusReason"
....... value[x] 0..1 CodeableConcept Przyczyna
Binding: PLeKOKAppointmentCancelationReasonVS (required)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 1..1 Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..0
......... system Σ 1..1 uri System kodowania
......... code Σ 1..1 code Kod
......... display Σ 1..1 string Nazwa
........ text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
..... url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history"
... status ?!Σ 1..1 code booked (wizyta zarejestrowana) | fulfilled (wizyta odbyła się) | cancelled (wizyta odwołana) | entered-in-error (wizyta błędnie zarejestrowana) | noshow (pacjent nie pojawił się)
Binding: PLeKOKAppointmentStatusVS (required)
... cancelationReason Σ 0..1 CodeableConcept Przyczyna anulowania rejestracji na wizytę. Wymagany w przypadku ustawienia statusu na 'canceled'
Binding: PLeKOKAppointmentCancelationReasonVS (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... system Σ 1..1 uri System kodowania
..... code Σ 1..1 code Kod
..... display Σ 1..1 string Nazwa
.... text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... serviceCategory Σ 1..1 CodeableConcept Kategoria
Binding: PLeKOKCardiacCareSeviceCategoryVS (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri System kodowania rodzajów świadzceń
Required Pattern: https://ezdrowie.gov.pl/ekok/fhir/CodeSystem/care-service-category-code-system
..... code Σ 1..1 code phc | amb | imp
..... display Σ 1..1 string Nazwa rodzaju świadczenia
... start Σ 1..1 instant Planowana data i godzina rozpoczęcia wizyty
... end Σ 1..1 instant Planowana data i godzina zakończenia wizyty
... created 1..1 dateTime Data rejestracji
... basedOn 1..1 Reference(ServiceRequest) Referencja do zasobu z danymi zlecenia wystawionego w ramach karty e-KOK
.... extension 0..0
.... reference ΣC 1..1 string Referencja do zasobu ServiceRequest
.... type Σ 1..1 uri Typ zasobu (ServiceRequest)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Closed by value:actor.type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:patient C 1..1 BackboneElement Pacjent
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Patient) Dane pacjenta
...... extension 0..0
...... reference ΣC 1..1 string Referencja do zasobu Patient
...... type Σ 1..1 uri Typ zasobu z danymi pacjenta (Patient)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Patient
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted
.... participant:location C 1..1 BackboneElement Placówka
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Location) Person, Location/HealthcareService or Device
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:healthcareLocationTechnicalCode 1..1 (Complex) Kod techniczny miejsca udzielania świadczeń
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code
........ extension 0..0
........ url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code"
........ value[x] 1..1 string Kod techniczny miejsca udzielania świadczeń
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
...... identifier Σ 1..1 Identifier Identyfikator miejsce udzielenia świadczenia
....... extension 0..0
....... system Σ 1..1 uri OID systemu identyfikacji Miejsca Udzielania Świadczeń
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string Identyfikator Miejsca Udzielania Świadczeń
Example General: 123456
...... display Σ 1..1 string Nazwa Miejsca Udzielania Świadczeń
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.extension:statusHistory.​extension:status.value[x] Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.extension:statusHistory.​extension:statusReason.​value[x] Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.status Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.cancelationReason Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.serviceCategory Base required PLeKOKCardiacCareSeviceCategoryVS 📦0.4.0 This IG
Appointment.basedOn.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:patient.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:patient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:location.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:location.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant, Appointment.participant:patient, Appointment.participant:location Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
date-pattern error Appointment.extension:statusHistory.extension:period.value[x].start, Appointment.extension:statusHistory.extension:period.value[x].end Nieprawidłowy format daty (prawidłowy format daty: YYYY-MM-DD) $this.toString().matches('^\\d{4}-((0[0-9])|(1[012]))-(([012][0-9])|3[01])$')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Struktura bazuje na Appointment

Summary

Mandatory: 29 elements(8 nested mandatory elements)
Fixed: 6 elements
Prohibited: 53 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Appointment.participant (Closed)

Widok Differential

Struktura bazuje na Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
... id 0..1 id Identyfikator logiczny zasobu (wartość nadawana przez system P1)
... meta 1..1 Meta Metadane zasobu
.... id 0..0
.... extension 0..0
.... versionId 0..1 id Wersja zasobu (wartość ustawiana przez system P1)
.... lastUpdated 0..1 instant Data aktualizacji zasobu (wartość ustawiana przez system P1)
.... source 0..1 uri Identyfikator źródła zasobu (wartość ustawiana przez system, przy rejestracji lub aktualizacji zasobu)
.... profile 1..1 canonical(StructureDefinition) PLeKOKAppointment
Fixed Value: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment
.... tag 0..0
... implicitRules 0..1 uri Wersja systemu (wartość ustawiana przez system P1)
... language 0..1 code Language of the resource content
Required Pattern: pl
... text 0..0
... contained 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
.... extension:statusHistory 1..* (Complex) Historia statusów rejestracji. Ostatni status na liście historii statusów musi być tożsamy z aktualnym statusem rejestracji
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history
..... Slices for extension Content/Rules for all slices
...... extension:status 1..1 Extension status
....... value[x] 1..1 code status
Binding: PLeKOKAppointmentStatusVS (required)
...... extension:period 1..1 Extension Okres czasu, w którym status był aktualny
....... value[x] 1..1 Period Okres
........ start C 1..1 dateTime Data początku okresu
Constraints: date-pattern
........ end C 0..1 dateTime Data końca okresu
Constraints: date-pattern
...... extension:statusReason 0..1 Extension Przyczyna zmiany statusu
....... value[x] 0..1 CodeableConcept Przyczyna
Binding: PLeKOKAppointmentCancelationReasonVS (required)
........ coding 1..1 Coding Code defined by a terminology system
......... extension 0..0
......... system 1..1 uri System kodowania
......... version 0..0
......... code 1..1 code Kod
......... display 1..1 string Nazwa
......... userSelected 0..0
........ text 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... modifierExtension 0..0
... identifier 0..0
... status 1..1 code booked (wizyta zarejestrowana) | fulfilled (wizyta odbyła się) | cancelled (wizyta odwołana) | entered-in-error (wizyta błędnie zarejestrowana) | noshow (pacjent nie pojawił się)
Binding: PLeKOKAppointmentStatusVS (required)
... cancelationReason 0..1 CodeableConcept Przyczyna anulowania rejestracji na wizytę. Wymagany w przypadku ustawienia statusu na 'canceled'
Binding: PLeKOKAppointmentCancelationReasonVS (required)
.... coding 1..1 Coding Code defined by a terminology system
..... extension 0..0
..... system 1..1 uri System kodowania
..... version 0..0
..... code 1..1 code Kod
..... display 1..1 string Nazwa
..... userSelected 0..0
.... text 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... serviceCategory 1..1 CodeableConcept Kategoria
Binding: PLeKOKCardiacCareSeviceCategoryVS (required)
.... extension 0..0
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri System kodowania rodzajów świadzceń
Required Pattern: https://ezdrowie.gov.pl/ekok/fhir/CodeSystem/care-service-category-code-system
..... version 0..0
..... code 1..1 code phc | amb | imp
..... display 1..1 string Nazwa rodzaju świadczenia
..... userSelected 0..0
.... text 0..0
... serviceType 0..0
... specialty 0..0
... appointmentType 0..0
... reasonCode 0..0
... reasonReference 0..0
... priority 0..0
... description 0..0
... supportingInformation 0..0
... start 1..1 instant Planowana data i godzina rozpoczęcia wizyty
... end 1..1 instant Planowana data i godzina zakończenia wizyty
... minutesDuration 0..0
... slot 0..0
... created 1..1 dateTime Data rejestracji
... comment 0..0
... patientInstruction 0..0
... basedOn 1..1 Reference(ServiceRequest) Referencja do zasobu z danymi zlecenia wystawionego w ramach karty e-KOK
.... id 0..0
.... extension 0..0
.... reference 1..1 string Referencja do zasobu ServiceRequest
.... type 1..1 uri Typ zasobu (ServiceRequest)
Fixed Value: ServiceRequest
.... identifier 0..0
.... display 0..0
... Slices for participant 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Closed by value:actor.type
.... participant:patient 1..1 BackboneElement Pacjent
..... type 0..0
..... actor 1..1 Reference(Patient) Dane pacjenta
...... id 0..0
...... extension 0..0
...... reference 1..1 string Referencja do zasobu Patient
...... type 1..1 uri Typ zasobu z danymi pacjenta (Patient)
Fixed Value: Patient
...... identifier 0..0
...... display 0..0
..... required 0..0
..... status 1..1 code accepted | declined | tentative | needs-action
Fixed Value: accepted
..... period 0..0
.... participant:location 1..1 BackboneElement Placówka
..... type 0..0
..... actor 1..1 Reference(Location) Person, Location/HealthcareService or Device
...... id 0..0
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:healthcareLocationTechnicalCode 1..1 (Complex) Kod techniczny miejsca udzielania świadczeń
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code
........ id 0..0
........ value[x] 1..1 string Kod techniczny miejsca udzielania świadczeń
...... reference 0..0
...... type 1..1 uri Type the reference refers to (e.g. "Patient")
Fixed Value: Location
...... identifier 1..1 Identifier Identyfikator miejsce udzielenia świadczenia
....... id 0..0
....... extension 0..0
....... use 0..0
....... type 0..0
....... system 1..1 uri OID systemu identyfikacji Miejsca Udzielania Świadczeń
....... value 1..1 string Identyfikator Miejsca Udzielania Świadczeń
....... period 0..0
....... assigner 0..0
...... display 1..1 string Nazwa Miejsca Udzielania Świadczeń
..... required 0..0
..... status 1..1 code accepted | declined | tentative | needs-action
Fixed Value: accepted
..... period 0..0
... requestedPeriod 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.extension:statusHistory.​extension:status.value[x] Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.extension:statusHistory.​extension:statusReason.​value[x] Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.status Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.cancelationReason Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.serviceCategory Base required PLeKOKCardiacCareSeviceCategoryVS 📦0.4.0 This IG

Constraints

Id Grade Path(s) Description Expression
date-pattern error Appointment.extension:statusHistory.extension:period.value[x].start, Appointment.extension:statusHistory.extension:period.value[x].end Nieprawidłowy format daty (prawidłowy format daty: YYYY-MM-DD) $this.toString().matches('^\\d{4}-((0[0-9])|(1[012]))-(([012][0-9])|3[01])$')

Widok kluczowych elementów

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Identyfikator logiczny zasobu (wartość nadawana przez system P1)
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu (wartość ustawiana przez system P1)
.... lastUpdated Σ 0..1 instant Data aktualizacji zasobu (wartość ustawiana przez system P1)
.... source Σ 0..1 uri Identyfikator źródła zasobu (wartość ustawiana przez system, przy rejestracji lub aktualizacji zasobu)
.... profile Σ 1..1 canonical(StructureDefinition) PLeKOKAppointment

Fixed Value: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment
... implicitRules ?!Σ 0..1 uri Wersja systemu (wartość ustawiana przez system P1)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
.... extension:statusHistory 1..* (Complex) Historia statusów rejestracji. Ostatni status na liście historii statusów musi być tożsamy z aktualnym statusem rejestracji
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status 1..1 Extension status
....... extension 0..0
....... url 1..1 uri "status"
....... value[x] 1..1 code status
Binding: PLeKOKAppointmentStatusVS (required)
...... extension:period 1..1 Extension Okres czasu, w którym status był aktualny
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Okres
........ start ΣC 1..1 dateTime Data początku okresu
Constraints: date-pattern
........ end ΣC 0..1 dateTime Data końca okresu
Constraints: date-pattern
...... extension:statusReason 0..1 Extension Przyczyna zmiany statusu
....... extension 0..0
....... url 1..1 uri "statusReason"
....... value[x] 0..1 CodeableConcept Przyczyna
Binding: PLeKOKAppointmentCancelationReasonVS (required)
........ coding Σ 1..1 Coding Code defined by a terminology system
......... extension 0..0
......... system Σ 1..1 uri System kodowania
......... code Σ 1..1 code Kod
......... display Σ 1..1 string Nazwa
........ text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
..... url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history"
... status ?!Σ 1..1 code booked (wizyta zarejestrowana) | fulfilled (wizyta odbyła się) | cancelled (wizyta odwołana) | entered-in-error (wizyta błędnie zarejestrowana) | noshow (pacjent nie pojawił się)
Binding: PLeKOKAppointmentStatusVS (required)
... cancelationReason Σ 0..1 CodeableConcept Przyczyna anulowania rejestracji na wizytę. Wymagany w przypadku ustawienia statusu na 'canceled'
Binding: PLeKOKAppointmentCancelationReasonVS (required)
.... coding Σ 1..1 Coding Code defined by a terminology system
..... extension 0..0
..... system Σ 1..1 uri System kodowania
..... code Σ 1..1 code Kod
..... display Σ 1..1 string Nazwa
.... text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... serviceCategory Σ 1..1 CodeableConcept Kategoria
Binding: PLeKOKCardiacCareSeviceCategoryVS (required)
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri System kodowania rodzajów świadzceń
Required Pattern: https://ezdrowie.gov.pl/ekok/fhir/CodeSystem/care-service-category-code-system
..... code Σ 1..1 code phc | amb | imp
..... display Σ 1..1 string Nazwa rodzaju świadczenia
... start Σ 1..1 instant Planowana data i godzina rozpoczęcia wizyty
... end Σ 1..1 instant Planowana data i godzina zakończenia wizyty
... created 1..1 dateTime Data rejestracji
... basedOn 1..1 Reference(ServiceRequest) Referencja do zasobu z danymi zlecenia wystawionego w ramach karty e-KOK
.... extension 0..0
.... reference ΣC 1..1 string Referencja do zasobu ServiceRequest
.... type Σ 1..1 uri Typ zasobu (ServiceRequest)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Closed by value:actor.type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:patient C 1..1 BackboneElement Pacjent
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Patient) Dane pacjenta
...... extension 0..0
...... reference ΣC 1..1 string Referencja do zasobu Patient
...... type Σ 1..1 uri Typ zasobu z danymi pacjenta (Patient)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Patient
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted
.... participant:location C 1..1 BackboneElement Placówka
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Location) Person, Location/HealthcareService or Device
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:healthcareLocationTechnicalCode 1..1 (Complex) Kod techniczny miejsca udzielania świadczeń
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code
........ extension 0..0
........ url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code"
........ value[x] 1..1 string Kod techniczny miejsca udzielania świadczeń
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
...... identifier Σ 1..1 Identifier Identyfikator miejsce udzielenia świadczenia
....... extension 0..0
....... system Σ 1..1 uri OID systemu identyfikacji Miejsca Udzielania Świadczeń
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string Identyfikator Miejsca Udzielania Świadczeń
Example General: 123456
...... display Σ 1..1 string Nazwa Miejsca Udzielania Świadczeń
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.extension:statusHistory.​extension:status.value[x] Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.extension:statusHistory.​extension:statusReason.​value[x] Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.status Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.cancelationReason Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.serviceCategory Base required PLeKOKCardiacCareSeviceCategoryVS 📦0.4.0 This IG
Appointment.basedOn.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:patient.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:patient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:location.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:location.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant, Appointment.participant:patient, Appointment.participant:location Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
date-pattern error Appointment.extension:statusHistory.extension:period.value[x].start, Appointment.extension:statusHistory.extension:period.value[x].end Nieprawidłowy format daty (prawidłowy format daty: YYYY-MM-DD) $this.toString().matches('^\\d{4}-((0[0-9])|(1[012]))-(([012][0-9])|3[01])$')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Widok Snapshot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4
... id Σ 0..1 id Identyfikator logiczny zasobu (wartość nadawana przez system P1)
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu (wartość ustawiana przez system P1)
.... lastUpdated Σ 0..1 instant Data aktualizacji zasobu (wartość ustawiana przez system P1)
.... source Σ 0..1 uri Identyfikator źródła zasobu (wartość ustawiana przez system, przy rejestracji lub aktualizacji zasobu)
.... profile Σ 1..1 canonical(StructureDefinition) PLeKOKAppointment

Fixed Value: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/pl-ekok-appointment
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... implicitRules ?!Σ 0..1 uri Wersja systemu (wartość ustawiana przez system P1)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
.... extension:statusHistory 1..* (Complex) Historia statusów rejestracji. Ostatni status na liście historii statusów musi być tożsamy z aktualnym statusem rejestracji
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status 1..1 Extension status
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "status"
....... value[x] 1..1 code status
Binding: PLeKOKAppointmentStatusVS (required)
...... extension:period 1..1 Extension Okres czasu, w którym status był aktualny
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Okres
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ start ΣC 1..1 dateTime Data początku okresu
Constraints: date-pattern
........ end ΣC 0..1 dateTime Data końca okresu
Constraints: date-pattern
...... extension:statusReason 0..1 Extension Przyczyna zmiany statusu
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "statusReason"
....... value[x] 0..1 CodeableConcept Przyczyna
Binding: PLeKOKAppointmentCancelationReasonVS (required)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 1..1 Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..0
......... system Σ 1..1 uri System kodowania
......... code Σ 1..1 code Kod
......... display Σ 1..1 string Nazwa
........ text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
..... url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/status-history"
... status ?!Σ 1..1 code booked (wizyta zarejestrowana) | fulfilled (wizyta odbyła się) | cancelled (wizyta odwołana) | entered-in-error (wizyta błędnie zarejestrowana) | noshow (pacjent nie pojawił się)
Binding: PLeKOKAppointmentStatusVS (required)
... cancelationReason Σ 0..1 CodeableConcept Przyczyna anulowania rejestracji na wizytę. Wymagany w przypadku ustawienia statusu na 'canceled'
Binding: PLeKOKAppointmentCancelationReasonVS (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... system Σ 1..1 uri System kodowania
..... code Σ 1..1 code Kod
..... display Σ 1..1 string Nazwa
.... text Σ 0..1 string Opis powodu. Wymagany w przypadku wyboru pozycji 'inny'
... serviceCategory Σ 1..1 CodeableConcept Kategoria
Binding: PLeKOKCardiacCareSeviceCategoryVS (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri System kodowania rodzajów świadzceń
Required Pattern: https://ezdrowie.gov.pl/ekok/fhir/CodeSystem/care-service-category-code-system
..... code Σ 1..1 code phc | amb | imp
..... display Σ 1..1 string Nazwa rodzaju świadczenia
... start Σ 1..1 instant Planowana data i godzina rozpoczęcia wizyty
... end Σ 1..1 instant Planowana data i godzina zakończenia wizyty
... created 1..1 dateTime Data rejestracji
... basedOn 1..1 Reference(ServiceRequest) Referencja do zasobu z danymi zlecenia wystawionego w ramach karty e-KOK
.... extension 0..0
.... reference ΣC 1..1 string Referencja do zasobu ServiceRequest
.... type Σ 1..1 uri Typ zasobu (ServiceRequest)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Closed by value:actor.type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:patient C 1..1 BackboneElement Pacjent
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Patient) Dane pacjenta
...... extension 0..0
...... reference ΣC 1..1 string Referencja do zasobu Patient
...... type Σ 1..1 uri Typ zasobu z danymi pacjenta (Patient)
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Patient
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted
.... participant:location C 1..1 BackboneElement Placówka
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Location) Person, Location/HealthcareService or Device
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:healthcareLocationTechnicalCode 1..1 (Complex) Kod techniczny miejsca udzielania świadczeń
URL: https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code
........ extension 0..0
........ url 1..1 uri "https://ezdrowie.gov.pl/ekok/fhir/StructureDefinition/healthcare-location-technical-code"
........ value[x] 1..1 string Kod techniczny miejsca udzielania świadczeń
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
...... identifier Σ 1..1 Identifier Identyfikator miejsce udzielenia świadczenia
....... extension 0..0
....... system Σ 1..1 uri OID systemu identyfikacji Miejsca Udzielania Świadczeń
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string Identyfikator Miejsca Udzielania Świadczeń
Example General: 123456
...... display Σ 1..1 string Nazwa Miejsca Udzielania Świadczeń
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Fixed Value: accepted

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.extension:statusHistory.​extension:status.value[x] Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.extension:statusHistory.​extension:statusReason.​value[x] Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.status Base required PLeKOKAppointmentStatusVS 📦0.4.0 This IG
Appointment.cancelationReason Base required PLeKOKAppointmentCancelationReasonVS 📦0.4.0 This IG
Appointment.serviceCategory Base required PLeKOKCardiacCareSeviceCategoryVS 📦0.4.0 This IG
Appointment.basedOn.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:patient.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:patient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:location.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:location.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant, Appointment.participant:patient, Appointment.participant:location Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
date-pattern error Appointment.extension:statusHistory.extension:period.value[x].start, Appointment.extension:statusHistory.extension:period.value[x].end Nieprawidłowy format daty (prawidłowy format daty: YYYY-MM-DD) $this.toString().matches('^\\d{4}-((0[0-9])|(1[012]))-(([012][0-9])|3[01])$')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Struktura bazuje na Appointment

Summary

Mandatory: 29 elements(8 nested mandatory elements)
Fixed: 6 elements
Prohibited: 53 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Appointment.participant (Closed)

 

Inne struktury profilu: CSV, Excel, Schematron